Procurement APIs
Update provided purchase order
| HTTP method | PUT |
| URI | https://api.rambase.net/procurement/orders/{purchaseOrderId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {purchaseOrderId} |
Purchase order identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 3000, version 14 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
PurchaseOrder
This field is optional.
>SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
>{String}</SuppliersReference>SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersReferenceNumber>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
This field is optional.
>{String}</ShipToAttention>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Supplier
This field is optional.
>SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
>{Integer}</SupplierId>ShipFrom
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Shipment
This field is optional.
>DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
>{String}</DeliveryTerms>DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
>{String}</DeliveryTermPlace>ShippingService
This field is optional.
>ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
>{Integer}</ShippingServiceId>Payment
This field is optional.
>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>PurchaseOrder
This field is optional.
": {SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
": "{String}",SuppliersReferenceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
This field is optional.
": "{String}",Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Supplier
This field is optional.
": {SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
": "{Integer}"ShipFrom
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Shipment
This field is optional.
": {DeliveryTerms
Default delivery terms for the supplier. The delivery terms is based on the Incoterms rules from ICC (International Chamber of Commerce).
Applicable domain values can be found here
This field is optional.
": "{String}",DeliveryTermPlace
A named place, which, together with the content of Delivery terms, determines where and when the costs, responsibility and risk for a shipment are transferred from the seller to the buye
This field is optional.
": "{String}",ShippingService
This field is optional.
": {ShippingServiceId
Shipping service identifier
Minimum value: 100000
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 100147 HTTP 404 | Notification type not found |
| Error 100199 HTTP 404 | Location not found |
| Error 102229 HTTP 400 | Location {0} is already defined on the product |
| Error 101493 HTTP 400 | Illegal update: New VAT code has VAT percentage different from old VAT code. |
| Error 101494 HTTP 400 | Illegal VAT code: Vat code and document has different VAT number |
| Error 101496 HTTP 400 | Illegal VAT code {0}: Check VAT FromPeriod and ToPeriod |
| Error 101495 HTTP 400 | Illegal VAT code: {0} |
| Error 107641 HTTP 400 | VAT code {0} has not an active VAT code setup |
| Error 100984 HTTP 400 | Illegal update. The General ledger posting has ST>4 |
| Error 100985 HTTP 400 | Illegal update. The General ledger posting has AGIO-calculation |
| Error 108105 HTTP 400 | Linking is not allowed for project order items for which have manually accrued handling |
| Error 108106 HTTP 400 | Linking is not allowed for project order item which is based on expense log |
| Error 101469 HTTP 400 | The object is not open for edit. To change currency, the object must be in status 1. |
| Error 101562 HTTP 400 | This currency is not supported by the supplier |
| Error 101689 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it contains standard products (type not equal to X or V). |
| Error 101690 HTTP 400 | You cannot change this purchase order to type 'REQUISITION' as it has assignments. |